////////////////////////////////////////////////////////////////////////////////////////////////////
/// Copyright (c) 2009 - 2010 RacoonStudios
///
/// Permission is hereby granted, free of charge, to any person obtaining a copy of this
/// software and associated documentation files (the "Software"), to deal in the Software
/// without restriction, including without limitation the rights to use, copy, modify, merge,
/// publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
/// to whom the Software is furnished to do so, subject to the following conditions:
///
/// The above copyright notice and this permission notice shall be included in all copies or
/// substantial portions of the Software.
///
/// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
/// INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
/// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
/// FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
/// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
/// DEALINGS IN THE SOFTWARE.
////////////////////////////////////////////////////////////////////////////////////////////////////

#pragma once
#ifndef win32interlocked_h__
#define win32interlocked_h__

#include "core/types.h"

namespace Win32
{
	////////////////////////////////////////////////////////////////////////////////////////////////////
	/// \class	Win32Interlocked
	///
	/// \brief	Window 32 interlocked. 
	///
	///	\todo	Add documentation.
	///
	/// \author	Markus
	/// \date	21.02.2010
	////////////////////////////////////////////////////////////////////////////////////////////////////
	class Win32Interlocked
	{
	public:

		////////////////////////////////////////////////////////////////////////////////////////////////////
		/// \fn	static int Increment(int volatile & var)
		///
		/// \brief	Increments. 
		///
		/// \author	Markus
		/// \date	21.02.2010
		///
		/// \param [in,out]	var	the variable. 
		///
		/// \return	. 
		////////////////////////////////////////////////////////////////////////////////////////////////////
		static int Increment(int volatile & var);

		////////////////////////////////////////////////////////////////////////////////////////////////////
		/// \fn	static int Decrement(int volatile & var)
		///
		/// \brief	Decrements. 
		///
		/// \author	Markus
		/// \date	21.02.2010
		///
		/// \param [in,out]	var	the variable. 
		///
		/// \return	. 
		////////////////////////////////////////////////////////////////////////////////////////////////////
		static int Decrement(int volatile & var);

		////////////////////////////////////////////////////////////////////////////////////////////////////
		/// \fn	static int Add(int volatile & var, int add)
		///
		/// \brief	Adds var.
		///
		/// \author	Markus
		/// \date	21.02.2010
		///
		/// \param [in,out]	var	the int volatile & to add. 
		/// \param	add			The int to add. 
		///
		/// \return	. 
		////////////////////////////////////////////////////////////////////////////////////////////////////
		static int Add(int volatile & var, int add);

		////////////////////////////////////////////////////////////////////////////////////////////////////
		/// \fn	static int Exchange(int volatile * dst, int val)
		///
		/// \brief	Exchanges. 
		///
		/// \author	Markus
		/// \date	21.02.2010
		///
		/// \param [in,out]	dst	If non-null, destination for the. 
		/// \param	val			The value. 
		///
		/// \return	. 
		////////////////////////////////////////////////////////////////////////////////////////////////////
		static int Exchange(int volatile * dst, int val);

		////////////////////////////////////////////////////////////////////////////////////////////////////
		/// \fn	static int CompareExchange(int volatile * dst, int exchange, int comparand)
		///
		/// \brief	Compare exchange. 
		///
		/// \author	Markus
		/// \date	21.02.2010
		///
		/// \param [in,out]	dst	If non-null, destination for the. 
		/// \param	exchange	The exchange. 
		/// \param	comparand	The comparand. 
		///
		/// \return	. 
		////////////////////////////////////////////////////////////////////////////////////////////////////
		static int CompareExchange(int volatile * dst, int exchange, int comparand);

	protected:

	private:

	};

}

#endif // win32interlocked_h__